<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ExceptionHandler</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ExceptionHandler</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ExceptionHandler class</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_mvc---action---ExceptionHandler.php.html">/mvc/action/ExceptionHandler.php</a> (line <span class="field">35</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																												
												<div class="method-definition">
											<span class="method-result">ExceptionHandler</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#execute" title="details" class="method-name">execute</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>, <span class="var-type"><a href="../mvc/ExceptionConfig.html">ExceptionConfig</a></span>&nbsp;<span class="var-name">&$config</span>, <span class="var-type"><a href="../mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>, <span class="var-type">formInstance</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#storeException" title="details" class="method-name">storeException</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">property</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"><a href="../mvc/ActionMessage.html">ActionMessage</a></span>&nbsp;<span class="var-name">$error</span>, <span class="var-type"><a href="../mvc/ForwardConfig.html">ForwardConfig</a></span>&nbsp;<span class="var-name">$forward</span>, <span class="var-type">scope</span>&nbsp;<span class="var-name">$scope</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">46</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ExceptionHandler</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">execute</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt; Handle the Exception. Return the ActionForward instance (if any)  returned by the called ExceptionHandler. &lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div> instance (if any) returned by          the called <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/ExceptionHandler.html">ExceptionHandler</a></span></div></li>
</ol></div>.</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">since:</span> Struts 1.1</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			execute
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>, <span class="var-type"><a href="../mvc/ExceptionConfig.html">ExceptionConfig</a></span>&nbsp;<span class="var-name">&$config</span>, <span class="var-type"><a href="../mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>, <span class="var-type">formInstance</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">ex</span>
				<span class="var-name">$e</span><span class="var-description">: The exception to handle</span>			</li>
					<li>
				<span class="var-type">ae</span>
				<span class="var-name">&$config</span><span class="var-description">: The ExceptionConfig corresponding to the exception</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping we are processing</span>			</li>
					<li>
				<span class="var-type">formInstance</span>
				<span class="var-name">&$form</span><span class="var-description">: The ActionForm we are processing</span>			</li>
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
				</ul>
		
			
	</div>
<a name="methodstoreException" id="storeException"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">storeException</span> (line <span class="line-number">124</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Default implementation for handling an <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/ActionMessage.html">ActionMessage</a></span></div></li>
</ol></div></p>
<p class="description"><p>generated from an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Exception</span></div></li>
</ol></div> during <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/Action.html">Action</a></span></div></li>
</ol></div>  delegation. The default implementation is to set an attribute of the  request or session, as defined by the scope provided (the scope from  the exception mapping). An <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/ActionMessages.html">ActionMessages</a></span></div></li>
</ol></div> instance is  created, the error is added to the collection and the collection is set  under the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Globals</span>.<span class="src-id">ERROR_KEY</span></div></li>
</ol></div>.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Struts 1.2</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			storeException
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">property</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"><a href="../mvc/ActionMessage.html">ActionMessage</a></span>&nbsp;<span class="var-name">$error</span>, <span class="var-type"><a href="../mvc/ForwardConfig.html">ForwardConfig</a></span>&nbsp;<span class="var-name">$forward</span>, <span class="var-type">scope</span>&nbsp;<span class="var-name">$scope</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The request we are handling</span>			</li>
					<li>
				<span class="var-type">property</span>
				<span class="var-name">$property</span><span class="var-description">: The property name to use for this error</span>			</li>
					<li>
				<span class="var-type">error</span>
				<span class="var-name">$error</span><span class="var-description">: The error generated from the exception mapping</span>			</li>
					<li>
				<span class="var-type">forward</span>
				<span class="var-name">$forward</span><span class="var-description">: The forward generated from the input path (from the                  form or exception mapping)</span>			</li>
					<li>
				<span class="var-type">scope</span>
				<span class="var-name">$scope</span><span class="var-description">: The scope of the exception mapping.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:15 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>